<!-- HTML header for doxygen 1.11.0-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Doxygen: XML Commands</title>
<link rel="icon" href="doxygen.ico" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen_manual.css" rel="stylesheet" type="text/css"/>
<link href="extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><a href="../index.html"><img alt="Logo" src="doxygen_logo.svg" height="35px"/></a></td>
  <td class="menu-item"><a href="index.html">Docs</a></td>
  <td class="menu-item"><a href="changelog.html">Changelog</a></td>
  <td class="menu-item"><a href="../helpers.html">Extensions</a></td>
  <td class="menu-item"><a href="../examples.html">Examples</a></td>
  <td class="menu-spacer">&#160;</td>
  <td class="menu-item" id="download">
      <img class="download-icon" src="../assets/download.svg" width="16px" height="16px" alt="Download doxygen"/>
      <a href="../download.html">Download</a>
  </td>
  <td class="menu-item" id="donate">
     <form action="https://www.paypal.com/cgi-bin/webscr" method="post" class="nav-item d-inline-flex px-1 mx-1">
       <input type="hidden" name="cmd" value="_donations" />
       <input type="hidden" value="doxygen@gmail.com" name="business" />
       <input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted" />
       <input type="hidden" name="lc" value="US" />
       <input type="hidden" name="tax" value="0" />
       <input type="hidden" name="item_name" value="Doxygen donation" />
       <input type="hidden" name="no_shipping" value="1" />
       <table class="donate">
         <tr>
           <td class="donate-button"><input type="image" width="74" height="21"
               src="https://www.paypal.com/en_GB/i/btn/btn_donate_SM.gif" border="0" name="submit"
               alt="Donate to Doxygen with PayPal!" /></td>
         </tr>
         <tr>
           <td class="currency"><select size="1" name="currency_code">
               <option selected="selected" value="EUR">&euro; (EUR)</option>
               <option value="USD">$ (USD)</option>
             </select></td>
         </tr>
       </table>
     </form>
   </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
     <div id="nav-tree-ads-carbon">
       <script async type="text/javascript" src="https://cdn.carbonads.com/carbon.js?serve=CK7DTK3M&placement=stacknl" id="_carbonads_js"></script>
     </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('xmlcmds.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div><div class="header">
  <div class="headertitle"><div class="title">XML Commands</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Doxygen supports most of the XML commands that are typically used in C# code comments. The XML tags are defined in Appendix D of the <a href="https://ecma-international.org/publications-and-standards/standards/ecma-334/">ECMA-334</a> standard, which defines the C# language. Unfortunately, the specification is not very precise and a number of the examples given are of poor quality.</p>
<p>Here is the list of tags supported by doxygen:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">XML Command</th><th class="markdownTableHeadLeft">Description </th></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_c"></a><a id="a634_;3Cc;3E" name="a634_;3Cc;3E"></a>  <code> &lt;c&gt;</code></td><td valign="top">Identifies inline text that should be rendered as a piece of code. Similar to using <code>&lt;tt&gt;</code>text<code>&lt;/tt&gt;</code>. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_code"></a><a id="a635_;3Ccode;3E" name="a635_;3Ccode;3E"></a>  <code> &lt;code&gt;</code></td><td valign="top">Set one or more lines of source code or program output. Note that this command behaves like <a class="el" href="commands.html#cmdcode">\code</a> ... <a class="el" href="commands.html#cmdendcode">\endcode</a> for C# code, but it behaves like the HTML equivalent <a class="el" href="htmlcmds.html#htmltag_CODE">&lt;CODE&gt;</a>...<a class="el" href="htmlcmds.html#htmltag_endCODE">&lt;/CODE&gt;</a> for other languages. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_description"></a><a id="a636_;3Cdescription;3E" name="a636_;3Cdescription;3E"></a>  <code> &lt;description&gt;</code></td><td valign="top">Part of a <a class="el" href="xmlcmds.html#xmltag_list">&lt;list&gt;</a> command, describes an item. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_example"></a><a id="a637_;3Cexample;3E" name="a637_;3Cexample;3E"></a>  <code> &lt;example&gt;</code></td><td valign="top">Marks a block of text as an example, ignored by doxygen. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_exception"></a><a id="a638_;3Cexception;3E" name="a638_;3Cexception;3E"></a>  <code> &lt;exception cref="member"&gt;</code></td><td valign="top">Identifies the exception a method can throw. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_include"></a><a id="a639_;3Cinclude;3E" name="a639_;3Cinclude;3E"></a>  <code> &lt;include&gt;</code></td><td valign="top">Can be used to import a piece of XML from an external file. Ignored by doxygen at the moment. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_inheritdoc"></a><a id="a640_;3Cinheritdoc;3E" name="a640_;3Cinheritdoc;3E"></a>  <code> &lt;inheritdoc&gt;</code></td><td valign="top">Can be used to insert the documentation of a member of a base class into the documentation of a member of a derived class that reimplements it. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_item"></a><a id="a641_;3Citem;3E" name="a641_;3Citem;3E"></a>  <code> &lt;item&gt;</code></td><td valign="top">List item. Can only be used inside a <a class="el" href="xmlcmds.html#xmltag_list">&lt;list&gt;</a> context. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_list"></a><a id="a642_;3Clist;3E" name="a642_;3Clist;3E"></a>  <code> &lt;list type="type"&gt;</code></td><td valign="top">Starts a list, supported types are <code>bullet</code> or <code>number</code> and <code>table</code>. A list consists of a number of <code>&lt;item&gt;</code> tags. A list of type table, is a two column table which can have a header. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_listheader"></a><a id="a643_;3Clistheader;3E" name="a643_;3Clistheader;3E"></a>  <code> &lt;listheader&gt;</code></td><td valign="top">Starts the header of a list of type "table". </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_para"></a><a id="a644_;3Cpara;3E" name="a644_;3Cpara;3E"></a>  <code> &lt;para&gt;</code></td><td valign="top">Identifies a paragraph of text. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_param"></a><a id="a645_;3Cparam;3E" name="a645_;3Cparam;3E"></a>  <code> &lt;param name="paramName"&gt;</code></td><td valign="top">Marks a piece of text as the documentation for parameter "paramName". Similar to using <a class="el" href="commands.html#cmdparam">\param</a>. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_paramref"></a><a id="a646_;3Cparamref;3E" name="a646_;3Cparamref;3E"></a>  <code> &lt;paramref name="paramName"&gt;</code></td><td valign="top">Refers to a parameter with name "paramName". Similar to using <a class="el" href="commands.html#cmda">\a</a>. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_permission"></a><a id="a647_;3Cpermission;3E" name="a647_;3Cpermission;3E"></a>  <code> &lt;permission&gt;</code></td><td valign="top">Identifies the security accessibility of a member. Ignored by doxygen. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_remarks"></a><a id="a648_;3Cremarks;3E" name="a648_;3Cremarks;3E"></a>  <code> &lt;remarks&gt;</code></td><td valign="top">Identifies the detailed description.  </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_returns"></a><a id="a649_;3Creturns;3E" name="a649_;3Creturns;3E"></a>  <code> &lt;returns&gt;</code></td><td valign="top">Marks a piece of text as the return value of a function or method. Similar to using <a class="el" href="commands.html#cmdreturn">\return</a>. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_see"></a><a id="a650_;3Csee;3E" name="a650_;3Csee;3E"></a>  <code> &lt;see cref="member"&gt;</code></td><td valign="top">Refers to a member. Similar to <a class="el" href="commands.html#cmdref">\ref</a>. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_seealso"></a><a id="a651_;3Cseealso;3E" name="a651_;3Cseealso;3E"></a>  <code> &lt;seealso cref="member"&gt;</code></td><td valign="top">Starts a "See also" section referring to "member". Similar to using <a class="el" href="commands.html#cmdsa">\sa</a> member. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_summary"></a><a id="a652_;3Csummary;3E" name="a652_;3Csummary;3E"></a>  <code> &lt;summary&gt;</code></td><td valign="top">In case this tag is used outside a <a class="el" href="htmlcmds.html#htmltag_DETAILS">&lt;DETAILS&gt;</a> tag this tag identifies the brief description. Similar to using <a class="el" href="commands.html#cmdbrief">\brief</a>. In case this tag is used inside a <a class="el" href="htmlcmds.html#htmltag_DETAILS">&lt;DETAILS&gt;</a> tag this tag identifies the heading of the <a class="el" href="htmlcmds.html#htmltag_DETAILS">&lt;DETAILS&gt;</a> tag. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_term"></a><a id="a653_;3Cterm;3E" name="a653_;3Cterm;3E"></a>  <code> &lt;term&gt;</code></td><td valign="top">Part of a <a class="el" href="xmlcmds.html#xmltag_list">&lt;list&gt;</a> command. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_typeparam"></a><a id="a654_;3Ctypeparam;3E" name="a654_;3Ctypeparam;3E"></a>  <code> &lt;typeparam name="paramName"&gt;</code></td><td valign="top">Marks a piece of text as the documentation for type parameter "paramName". Similar to using <a class="el" href="commands.html#cmdparam">\param</a>. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_typeparamref"></a><a id="a655_;3Ctypeparamref;3E" name="a655_;3Ctypeparamref;3E"></a>  <code>&lt;typeparamref name="paramName"&gt;</code></td><td valign="top">Refers to a parameter with name "paramName". Similar to using <a class="el" href="commands.html#cmda">\a</a>. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_value"></a><a id="a656_;3Cvalue;3E" name="a656_;3Cvalue;3E"></a>  <code> &lt;value&gt;</code></td><td valign="top">Identifies a property. Ignored by doxygen. </td></tr>
<tr>
<td valign="top"><a class="anchor" id="xmltag_CDATA"></a><a id="a657_;3C;21;5BCDATA;5B...;5D;5D;3E" name="a657_;3C;21;5BCDATA;5B...;5D;5D;3E"></a>  <code> &lt;![CDATA[...]]&gt;</code></td><td valign="top">The text inside this tag (on the ...) is handled as normal doxygen comment except for the XML special characters <code>&lt;</code>, <code>&gt;</code> and <code>&amp;</code> that are used as if they were escaped. </td></tr>
</table>
<p>Here is an example of a typical piece of code using some of the above commands:</p>
<div class="fragment"><div class="line"><span class="comment">/// &lt;summary&gt;</span><span class="comment"></span></div>
<div class="line"><span class="comment">/// A search engine.</span></div>
<div class="line"><span class="comment">/// &lt;/summary&gt;</span></div>
<div class="line"><span class="comment"></span><span class="keyword">class </span>Engine</div>
<div class="line">{<span class="comment"></span></div>
<div class="line"><span class="comment">  /// &lt;summary&gt;</span></div>
<div class="line"><span class="comment">  /// The Search method takes a series of parameters to specify the search criterion</span></div>
<div class="line"><span class="comment">  /// and returns a dataset containing the result set.</span></div>
<div class="line"><span class="comment">  /// &lt;/summary&gt;</span></div>
<div class="line"><span class="comment">  /// &lt;param name=&quot;connectionString&quot;&gt;the connection string to connect to the</span></div>
<div class="line"><span class="comment">  /// database holding the content to search&lt;/param&gt;</span></div>
<div class="line"><span class="comment">  /// &lt;param name=&quot;maxRows&quot;&gt;The maximum number of rows to</span></div>
<div class="line"><span class="comment">  /// return in the result set&lt;/param&gt;</span></div>
<div class="line"><span class="comment">  /// &lt;param name=&quot;searchString&quot;&gt;The text that we are searching for&lt;/param&gt;</span></div>
<div class="line"><span class="comment">  /// &lt;returns&gt;A DataSet instance containing the matching rows. It contains a maximum</span></div>
<div class="line"><span class="comment">  /// number of rows specified by the maxRows parameter&lt;/returns&gt;</span></div>
<div class="line"><span class="comment"></span>  <span class="keyword">public</span> DataSet Search(<span class="keywordtype">string</span> connectionString, <span class="keywordtype">int</span> maxRows, <span class="keywordtype">int</span> searchString)</div>
<div class="line">  {</div>
<div class="line">    DataSet ds = <span class="keyword">new</span> DataSet();</div>
<div class="line">    <span class="keywordflow">return</span> ds;</div>
<div class="line">  }</div>
<div class="line">}</div>
</div><!-- fragment --><p> 
Go to the <a href="emojisup.html">next</a> section or return to the
 <a href="index.html">index</a>.
 </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0 </li>
  </ul>
</div>
</body>
</html>
